Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prettify Cycamore docs #626

Merged
merged 4 commits into from
Sep 22, 2024
Merged

Prettify Cycamore docs #626

merged 4 commits into from
Sep 22, 2024

Conversation

bennibbelink
Copy link
Contributor

Makes essentially the same changes as cyclus/cyclus#1787

zip for preview
html.zip

Copy link

github-actions bot commented Sep 19, 2024

Build Status Report - 390f3bc - 2024-09-21 10:02:24 -0400

Build FROM cyclus_20.04_apt/cyclus:latest
  • Cycamore: Success
  • Cymetric: Success
Build FROM cyclus_20.04_apt/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_20.04_conda/cyclus:latest
  • Cycamore: Success
  • Cymetric: Success
Build FROM cyclus_20.04_conda/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_22.04_apt/cyclus:latest
  • Cycamore: Success
  • Cymetric: Success
Build FROM cyclus_22.04_apt/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_22.04_conda/cyclus:latest
  • Cycamore: Success
  • Cymetric: Success
Build FROM cyclus_22.04_conda/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️

@bennibbelink bennibbelink requested a review from gonuke September 19, 2024 11:14
Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - just one question about reusing the stylesheet from cyclus

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we get this from cyclus rather than including it again?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could modify the cyclus build to install the stylesheet somewhere in ${INSTALL_DIR}/share/cyclus (perhaps we add a doc/ subdirectory). I'm not sure how else to get it from cyclus, what do you think?

Copy link
Member

@gonuke gonuke Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to do the same with the logo?

@gonuke
Copy link
Member

gonuke commented Sep 20, 2024

I'm happy to merge this now and wait for style sheet cross-repo fixes...

Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @bennibbelink

@bennibbelink
Copy link
Contributor Author

bennibbelink commented Sep 20, 2024

Something odd is happening... the new style changes (for cyclus) are present in the artifact generated by cyclus.github.com actions but I'm not seeing them in the published site. The docs were present before adding them back into the build so I'm wondering if there's another server somewhere?

@bennibbelink
Copy link
Contributor Author

Aha! The cyclus repo has Pages set up to serve the docs. Is it okay if I turn this (and the cycamore one) off? That way the docs will be accessible from just the cyclus.github.com site

@gonuke
Copy link
Member

gonuke commented Sep 21, 2024

Just to make sure I understand... it seems that https://fuelcycle.org/cyclus/api/ is resolving to be the pages that are produced by GitHub at cyclus/cyclus on the gh-pages branch?

And that is blocking the ability to simply serve docs from the website file structure....

I think it's probably OK to turn of pages since the same URL will serve the new information and we never had a mechanism to automate the update of the go-pages.

The other alternative would be something that guarantees that the gh-pages are updated with every merged PR and/or release.

@bennibbelink
Copy link
Contributor Author

it seems that https://fuelcycle.org/cyclus/api/ is resolving to be the pages that are produced by GitHub at cyclus/cyclus on the gh-pages branch?

And that is blocking the ability to simply serve docs from the website file structure....

Yes, this is my understanding.

The other alternative would be something that guarantees that the gh-pages are updated with every merged PR and/or release.

That is also an option. It would require that we maintain actions in cylus and cycamore to do this. I think I would lean toward managing all of the site content in one place (cyclus.github.com's Dockerfile) for the sake of transparency. Having subpaths of a website served from separate repositories doesn't feel very intuitive, and is part of the reason it took me so long to understand where those docs were being produced.

@bennibbelink
Copy link
Contributor Author

Also I went ahead and changed this to find the stylesheet/gif at the location installed by cyclus.

@gonuke gonuke merged commit b040cdf into cyclus:main Sep 22, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants